<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>OdaDataSetParam Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">OdaDataSetParam Structure</p>
<h1>Structure Overview</h1>
<div class="section-text">
Describes an input and/or output parameter of the ODA data 
set query.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>OdaDataSetParam</td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-allowNull">allowNull</a></dt>
<dd>Whether a null value is allowed for this parameter.</dd>
<dt><a href="#Property-dataType">dataType</a></dt>
<dd>The optional data type of the parameter.</dd>
<dt><a href="#Property-defaultValue">defaultValue</a></dt>
<dd>The BIRT expression that defines the default value of the input parameter.</dd>
<dt><a href="#Property-isInput">isInput</a></dt>
<dd>Whether the parameter is of input mode.</dd>
<dt><a href="#Property-isOptional">isOptional</a></dt>
<dd>Whether the report must provide a value for the input parameter.</dd>
<dt><a href="#Property-isOutput">isOutput</a></dt>
<dd>Whether the parameter is of output mode.</dd>
<dt><a href="#Property-name">name</a></dt>
<dd>The name of the parameter.</dd>
<dt><a href="#Property-nativeDataType">nativeDataType</a></dt>
<dd>The data type know to an ODA user.</dd>
<dt><a href="#Property-nativeName">nativeName</a></dt>
<dd>The name known to an ODA user.</dd>
<dt><a href="#Property-paramName">paramName</a></dt>
<dd>The name of the report parameter that the parameter refers to.</dd>
<dt><a href="#Property-position">position</a></dt>
<dd>The 1-based position of the parameter, as defined by 
the underlying driver.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>The data set parameter definition element describes the 
parameters of the data set query. A parameter can be input only, output only, 
or both. </p></div>
<h3>See Also</h3>

<div class="section-text">
<p>The Parameter Definitions section above for the rules to 
identify a parameter by name vs. position</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-allowNull">allowNull Property</a></h2>

<p class="section-text">Whether a null value is allowed for this parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Allow Null</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>If true, the parameter value can be null. If false, the 
value cannot be null.</p></div>

<hr>
<h2><a name="Property-dataType">dataType Property</a></h2>

<p class="section-text">The optional data type of the parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (paramType)</td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Data Type</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>string</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>string</td>
<td>String</td>
<td>string</td>
<td>Arbitrary Unicode text.</td></tr>
<tr><td>float</td>
<td>Float</td>
<td>float</td>
<td>A scientific amount 
    using the usual floating point notation.</td></tr>
<tr><td>decimal</td>
<td>Decimal</td>
<td>decimal</td>
<td>Any type of number 
    including currency. Fixed decimal, arbitrary precision.</td></tr>
<tr><td>dateTime</td>
<td>Date Time</td>
<td>dateTime</td>
<td>A date, time or 
    combination of date and time.</td></tr>
<tr><td>boolean</td>
<td>Boolean</td>
<td>boolean</td>
<td></td></tr>
<tr><td>integer</td>
<td>Integer</td>
<td>integer</td>
<td>A whole number.</td></tr>
<tr><td>date</td>
<td>Date</td>
<td>date</td>
<td></td></tr>
<tr><td>time</td>
<td>Time</td>
<td>time</td>
<td></td></tr>
<tr><td>javaObject</td>
<td>Java Object</td>
<td>javaObject</td>
<td></td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The optional data type of the parameter. Required only 
for data sets that require this information. Complex data set parameter data 
types, such as structure or table parameters of a query, are reserved for future 
releases, and are not listed in the Choices specification. </p></div>

<hr>
<h2><a name="Property-defaultValue">defaultValue Property</a></h2>

<p class="section-text">The BIRT expression that defines the default value of the input parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Expression Type:</td>
<td>any</td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Default Value</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The expression that gets evaluated and its resulting 
value assigned as default value of the input parameter. The default value 
expression, if defined, is automatically bound to the parameter only if no 
explicit parameter binding is defined in the data set and its corresponding 
report parameter. </p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Data Set <span style="font-family: Courier New"> 
ParamBinding</span> structureReport Item <span style="font-family: Courier New"> 
paramBindings</span> property</p></div>

<hr>
<h2><a name="Property-isInput">isInput Property</a></h2>

<p class="section-text">Whether the parameter is of input mode.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Is Input</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Indicates whether the parameter is of input mode. If 
true, this is an input parameter; if false, this is not an input parameter.</p></div>

<hr>
<h2><a name="Property-isOptional">isOptional Property</a></h2>

<p class="section-text">Whether the report must provide a value for the input parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Is Optional</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>If false, the report must provide a value for the input 
parameter. If true, the value is optional. This property value is not relevant 
if the <span style="font-family: Courier New">defaultValue</span> property is 
defined with a value.</p></div>

<hr>
<h2><a name="Property-isOutput">isOutput Property</a></h2>

<p class="section-text">Whether the parameter is of output mode.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Is Output</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Indicates whether the parameter is of output mode. If 
true, this is an output parameter; if false, this is not an output parameter.</p></div>

<hr>
<h2><a name="Property-name">name Property</a></h2>

<p class="section-text">The name of the parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>Yes</td></tr>
<tr><td>Display Name:</td>
<td>Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The name of the parameter. Required. Must be unique 
within a data set definition.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>The Parameter Definitions section above for the naming rules</p></div>

<hr>
<h2><a name="Property-nativeDataType">nativeDataType Property</a></h2>

<p class="section-text">The data type know to an ODA user.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Native Data Type Code</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p> This is the data type known to an ODA custom designer and runtime driver, and is provided by a custom ODA designer in an oda.design.ParameterDefinition. </p></div>

<hr>
<h2><a name="Property-nativeName">nativeName Property</a></h2>

<p class="section-text">The name known to an ODA user.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#literalString">literalString</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Native Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p> This is the name known to an ODA custom designer and runtime driver, and is provided by a custom ODA designer in an oda.design.ParameterDefinition. </p></div>

<hr>
<h2><a name="Property-paramName">paramName Property</a></h2>

<p class="section-text">The name of the report parameter that the parameter refers to.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Parameter Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The parameter can explicitly link to a report parameter.  Once this explicit 
link is applied, the defaultValue is then ignored and overriden by the defaultValue 
in the linked report parameter. </p></div>

<hr>
<h2><a name="Property-position">position Property</a></h2>

<p class="section-text">The 1-based position of the parameter, as defined by 
the underlying driver.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Position</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The 1-based position of the parameter, as defined by the 
underlying driver. Required for data sets that identify input parameters by 
position instead of name. Ignored otherwise.</p></div>
</body>
</html>
